ATSUGetIndFontVariation

OSStatus ATSUGetIndFontVariation (
                     ATSUFontID iFont,
                     ItemCount iVariationIndex,
                     ATSUFontVariationAxis *oATSUFontVariationAxis,
                     ATSUFontVariationValue *oMinimumValue,
                     ATSUFontVariationValue *oMaximumValue,
                     ATSUFontVariationValue *oDefaultValue);

iFontID

A value of type ATSUFontID. Pass the ID of the font whose font variation you want information about.

iVariationIndex

A 0-based index. Pass a value between 0 and one less than the count passed back in the function ATSUCountFontVariations.

oATSUFontVariationAxis

A pointer to a value of type ATSUFontVariationAxis. On return, the axis of the font variation. You cannot pass NULL for this parameter.

oMinimumValue

A pointer to a value of type ATSUFontVariationValue. On return, the minimum value of the variation axis. You cannot pass NULL for this parameter.

oMaximumValue

A pointer to a value of type ATSUFontVariationValue. On return, the maximum value of the variation axis. You cannot pass NULL for this parameter.

oDefaultValue

A pointer to a value of type ATSUFontVariationValue. On return, the default value of the variation axis. You cannot pass NULL for this parameter.

function result

A result code. The result code kATSUInvalidFontErr indicates that the ID does not correspond to any installed font. For a list of other ATSUI-specific result codes, see Result Codes.

DISCUSSION

The ATSUGetIndFontVariation function obtains, for an indexed font variation, its axis and the default, minimum, and maximum values of that axis. Some fonts are capable of generating a wide range of stylistic changes. Such a font contains font variation axes, each of which describes a particular stylistic attribute and the range of values that the font can use. Each axis has a minimum, maximum, and default value. The minimum and maximum values determine the range of values that the variation axis covers. A font may also name specific values along a variation axis as font instances.

VERSION NOTES

Available beginning with ATSUI 1.0.